Predefined Item Properties
The tables below are a summary of the attributes defined by Apis Hive, which may be applied to any item in Apis Hive.
Some Apis Hive attributes have enumerated values, e.g. you may select between a predefined list of attribute values. Check the list of enumerated values and matching integers to get an overview of these attributes.
Internal attributes
Note: These attributes should not be added
| ID | Name | Description | Type |
| 5000 | Handle | Handle of an item - used when persisting the runtime state. | 4 byte integer |
| 5001 | TypeID | The type ID of an item. | 4 byte integer |
| 5003 | ItemID | The name of the item. | string |
| 5002 | InitValue | The initial value of an item. | - |
| 5045 | InitValueQuality | Initial value quality of an item (only valid when having an InitValue). | - |
| 5046 | InitValueTimestamp | Initial value timestamp of an item (only valid when having an InitValue). | - |
| 5047 | InitVQTFromHoneystore | If true, the initial value, quality and timestamp will be fetched from the last logged sample in Apis Honeystore. Note! To successfully use this attribute, the item in question must be logged to Honeystore by an ApisLoggerBee module. | Boolean |
Alternative value presentations
| ID | Name | Description | Type |
|---|---|---|---|
| 5004 | RawValue | The Raw 32-bit untranslated value. | 4 byte integer |
| 5005 | Scale | Linear transformation multiplier, a floating-point value. | 8 byte real |
| 5006 | Offset | Linear transformation addend, floating point value. | 8 byte real |
Vector and matrix attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5007 | Dimension | The number of elements for a vector item (vector only) | 2 byte unsigned integer |
| 5008 | Rows | The number of rows for a matrix item (matrix item only) | 2 byte unsigned integer |
| 5009 | Columns | The number of columns for a matrix item (matrix item only) | 2 byte unsigned integer |
Item location attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5010 | ProcStationID | Process station ID, a 32 bit integer | 4 byte integer |
| 5011 | ProcArea | Process area | string |
| 5012 | Location | General location attribute string | string |
| 5013 | Station | Station name | string |
Object attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5015 | ObjectClass | The object class this item belongs to | string |
| 5016 | ObjectInstance | The object instance this item belongs to | string |
| 5017 | ObjectProperty | The object property this item represents | string |
Item bus/network location attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5020 | Address | Bus/network address 1 | 4 byte integer |
| 5021 | Address2 | Bus/network address 2 | 4 byte integer |
| 5022 | Address3 | Bus/network address 3 | 4 byte integer |
| 5023 | Address4 | Bus/network address 4 | 4 byte integer |
| 5026 | Segment | Bus/network segment number | 2 byte integer |
| 5028 | SegmentPos | Position within segment | 2 byte integer |
Attributes related to other source(s)
| ID | Name | Description | Type |
|---|---|---|---|
| 5030 | SrcItemID | Item ID in source (often defaults to Item Name in Apis) | string |
| 5031 | SrcUaNodeId | UA NodeID in source, mostly relevant from OPC UA communication modules. | string |
| 5032 | InstrumentName | Instrument name | string |
Attributes related to db addressing
| ID | Name | Description | Type |
|---|---|---|---|
| 5034 | Source | The source of the item | string |
| 5035 | Table | The table of the item | string |
| 5036 | Record | The record of the item | string |
| 5037 | Field | The field of the item | string |
Directional attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5040 | Direction | Direction flag, Input when false or Output when true | Boolean |
Display attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5050 | Display | Operator display associated with the item | string |
| 5054 | Xpos | X-pos, graphical x-position of the item | 4 byte integer |
| 5055 | Ypos | Y-pos, graphical y-position of the item | 4 byte integer |
| 5056 | Width | Width, width of the item | 4 byte integer |
| 5057 | Height | Height, height of the item | 4 byte integer |
Device attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5060 | DevType | Device type | string |
| 5062 | DevVendor | Device vendor | string |
| 5064 | DevSerNum | Device serial number | string |
Attributes related to items in modules
| ID | Name | Description | Type |
| 5070 | MaxStringLength | An indication of the maximum length of the value of a string item. Must be used when logging string items to the Apis Honeystore historian, to control how many characters will be stored for each sample. | 4 byte integer |
| 5071 | MaxCacheDuration | When the item are logged to Apis Honeystore, the maximum duration in seconds, for the item cache when the item is logged by ApisLoggerBee! | 4 byte unsigned integer |
| 5080 | LowerBound | LBound, The lower bound of items in vector | 4 byte real |
| 5081 | UpperBound | UBound, The upper bound of items in vector | 4 byte real |
| 5090 | RowNames | The names of the rows in a vector or matrix, separated by ';' | array of strings |
| 5091 | ColNames | The names of the columns in a matrix, separated by ';' | array of strings |
| 5100 | ArgumentItem | An item whose value is used to calculate this item | string |
| 5105 | FormatString | A general purpose format string, used when applying string formatting to calculate the value of this item. | string |
| 5110 | Expression | An expression used to calculate the value of this item | string |
| 5111 | Expressions | An array of expressions used to calculate the value of this item | array of string |
| 5130 | Rate | An attribute which keeps the value rate | 8 byte unsigned integer |
| 5135 | Horizon | An attribute which keeps the value horizon | 8 byte unsigned integer |
| 5220 | Coefficients | Vector of coefficients used for calculation purposes | array of 8 byte real |
Composition attributes
| ID | Name | Description | Type |
| 5500 | Parent | The Item handle of the parent item to this item, an item in the same module as this item. | 4 byte integer |
| 5502 | ParentItem | The Item name of the parent item to this item, an item in the same module as this item. | string |
| 5505 | Aggregate | The item handle of the aggregate this item is part of | 4 byte integer |
| 5510 | InputItemsLocal | Array of item handles regarded as input-items to this item, only for items in the same module. | array of 4 byte integers |
| 5511 | InputItems | Array of item handles regarded as input-items to this item, for items in any module. | array of 4 byte integers |
| 5514 | InputFlags | Flags associated with the inputs | array of 4 byte integers |
| 5520 | OutputItemsLocal | Array of item handles regarded as output-items from this item, only for items in the same module. | array of 4 byte integers |
| 5521 | OutputItems | Array of item handles regarded as output-items from this item, for items in any module. | array of 4 byte integers |
| 5524 | OutputFlags | Flags associated with the outputs | array of 4 byte integers |
Alarm attributes
| ID | Name | Description | Type |
| 5600 | AlmSeverity | Severity of alarm associated with this item (according to OPC AE). 1 is the lowest, while 1000 is the highest. | 4 byte integer |
| 5610 | AlmSeverityList | Severity of alarm associated with this item (according to OPC AE). 1 to 1000 as the allowable range. | string |
| 5630 | AlmNormalState | The normal state of a discrete alarm/event (according to OPC AE) associated with this item. A deviation from this value will generate a discrete event. | Variant |
| 5635 | AlmActiveDelayPeriods | The number of periods an item is active before an alarm is raised. | 2 byte integer |
| 5640 | AlmWatchdogPeriods | The max number of periods this item can have the same value before a watchdog alarm is raised. | 2 byte integer |
| 5650 | AlmInhibitItem | The Item ID of another item whose value will be used to inhibit this alarm if set to true. Changed from a string to a 4 byte unsigned integer at start-up, i.e. 4 byte unsigned integer runtime | string |
| 5652 | AlmInhibitOffDelay | The time in milliseconds the alarm inhibit state is delayed before going off | 4 byte integer |
| 5653 | AlmResetItem | The Item ID of another item, whose value (when true) will reset the alarm of the source when it is inhibitted | string |
General purpose attributes
| ID | Name | Description | Type |
| 5800 | Text1 | General purpose attribute | string |
| 5801 | Text2 | General purpose attribute | string |
| 5802 | Text3 | General purpose attribute | string |
| 5803 | Text4 | General purpose attribute | string |
| 5810 | ActivationCount | The number of times this item has been activated | 4 byte unsigned integer |
| 5811 | ExecutionCount | The number of times this item has been executed | 4 byte unsigned integer |
| 5900 | UserLev | The user level needed to access this item 0-255 (BYTE) | 2 byte unsigned integer |
| 5940 | ExtendedRights | Extended access rights, used to restrict access to items beyond the OPC Item attributes. | 1 byte unsigned integer |
| 5950 | TypeFlags | This item is protected from users without the required level | 4 byte integer |
Data validation attributes
| ID | Name | Description | Type |
| 5670 | DvMethod | The method that decides which data validation tests to use. See "Data Validation Method". | 2 byte unsigned integer |
| 5672 | DvHiRange | The high limit for a DV range check | 8 byte real |
| 5673 | DvLoRange | The low limit for a DV range check | 8 byte real |
| 5674 | DvMaxRoc | The maximum rate of change for a DV rate of change check | 8 byte real |
| 5676 | DvWdTime | The time limit in seconds for a DV watchdog check | 8 byte real |
| 5677 | DvCompareItem | The comperand item to use when using any of the difference data-validation methods, ie. The difference is calculated by subtracting the value of the item referenced from the value of the item owning this attribute. | string |
| 5678 | DvCompareValue | The compare-value to use when using any of the difference data-validation methods. i.e. If the difference is bigger than the value of this attribute, the data is invalid. | 8 byte real |
| 5680 | DvSPCUCL | The upper control limit in SPC | 8 byte real |
| 5681 | DvSPCLCL | The lower control limit in SPC | 8 byte real |
| 5682 | DvSPCTest | The value assigned causes tests to be performed (multiple selects possible) | string |
| 5683 | DvSPCUSL | The upper SPC specification limit item reference, specified as an item reference or value directly. | string |
| 5684 | DvSPCLSL | The lower SPC specification limit item reference, specified as an item reference or value directly. | string |
| 5685 | DvSPCCL | The central line in SPC, specified as an item reference or value directly. If CL is not specified, UCL and LCL will be used to calculate it. | string |
| 5690 | DvSubstMethod | This method decides which data validation substitute value to use, see Data Validation Substitution Method. | 2 byte unsigned integer |
| 5692 | DvAltExtItem | An alternative external item, to fetch a DV substitute value from | string |
| 5695 | DvSuppressAlarm | If true (default behaviour), successive DV alarms of same subcondition are suppressed from being notified to the Alarm server of this Hive instance, ie. suppressed from any AE clients and Alarm database. If false, no DV alarms are suppressed. | Boolean |
External item transfer control and monitoring related attributes
| ID | Name | Description | Type |
| 5960 | ExtItemMetaTransfer | An enum deciding what kind of metadata to transfer from source to destination external item(s).
**EngineeringUnit** - The _EU_ and _Unit_ attributes are transferred. **Description** - The _Description_ attribute is transferred. **EURange** - The _High/Low EU_ attrbutes are transferred. |
4 byte unsigned integer |
| 5970 | MonMethod | The method that decides how external items are monitored\. See Pulse Monitoring | 2 byte unsigned integer |
| 5971 | MonTrueValue | This value is set on the monitoring item if the monitoring method is true | Variant |
| 5972 | MonFalseValue | This value is set on the monitoring item if the monitoring method is false | Variant |
| 5980 | ExtTransferCtrlMethod | The control method that decides when external items are transferred. See "External Item Data Transfer Control Methods" | 2 byte unsigned integer |
| 5982 | ExtTransferCtrlItem | The Item ID of another item, whose value will control the transfer of external item values to this item | string |
| 5984 | ExtTransferCtrlArgument | The argument to use with the method | string |
| 5986 | ExtTransferCtrlInhibitQuality | The quality to set when external item value transfer is inhibited. One of: none=0 quality: bad=65536 quality: uncertain=65600 quality: good=65728 quality: bad: config error=65540 quality: bad:not connected=65544 quality: bad:device failure=65548 quality: bad:sensor failure=65552 quality: bad:last known value=65556 quality: bad:comm failure=65560 quality: bad:out of service=65564 quality: bad:waiting for initial data=65568 quality: uncertain:last usable=65604 quality: uncertain:sensor not accurate=65616 quality: uncertain:engineering units exceeded=65620 quality: uncertain:sub normal=65624 quality: good:local override=65752 |
4 byte unsigned integer |
| 5990 | ExtRowSelect | The vector/matrix row in an external vector/matrix item to copy to this scalar item | 2 byte integer |
| 5991 | ExtColSelect | The vector/matrix column in an external vector/matrix item to copy to this scalar item | 2 byte integer |
| 5994 | ExternalItem Filters | One or more item name template(s) to use for connecting many external items. When set not an empty array, this attribute takes control over the external item configuration for its item. This means that upon startup, and when changing this attribute at run-time, an operation is triggered that resolves all matching items and connects them to the as external items. Any existing connections no longer matching the filter(s) are removed. An empty array is ignored, and external items can be configured as if this attribute were not present on the item. | array of string |
| 5998 | ExtItemPaddingValue | A padding value to be used when assigning missing external item values to an array item, ie. when assigning a source array item of dim 3 to a target item of dim 5 | - |
| 5999 | ExtItemOverrideMethod | This attribute decides what method to use when assigning a value from an external item, see external item External Item Override Methods | 2 byte unsigned integer |
External item attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 20000 | ExternalItem1 | External Item (Apis item name of the external item which will be automatically copied to this item) | string |
| 85535 | ExternalItemMax | Max external item ID | string |
PDS Connection attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5714 | ProcessCell | The PDS Process Cell associated with this item | 4 byte integer |
| 5715 | ProcessUnitClass | The PDS Process Unit Class associated with this item | 4 byte integer |
| 5716 | ProcessUnit | The PDS Process Unit associated with this item | 4 byte integer |
| 5718 | Equipment | The PDS Equipment associated with this item | 4 byte integer |
| 5730 | Identifier | The PDS Identifier associated with this item | 4 byte integer |
| 5732 | MaterialDefinition | The PDS Material Definition associated with this item | 4 byte integer |
| 5734 | MaterialClass | The PDS Material Class associated with this item | 4 byte integer |
| 5736 | MaterialQuality | The PDS Material Quality associated with this item | 4 byte integer |
| 5742 | CarrierClass | The PDS Carrier Class associated with this item | 4 byte integer |
| 5744 | Carrier | The PDS Carrier associated with this item | 4 byte integer |
| 5752 | DataClass | The PDS Data Class associated with this item | 4 byte integer |
| 5754 | DataDefinition | The PDS Data Definition associated with this item | 4 byte integer |
| 5764 | EventSource | The PDS Event Source associated with this item | 4 byte integer |
| 5774 | EU | The PDS Engineering unit (engineering unit) associated with this item | 4 byte integer |
| 5775 | GuiEU | The default GUI PDS Engineering Unit associated with this item. | 4 byte integer |
APIS Messaging related attributes
| ID | Name | Description | Type |
|---|---|---|---|
| 5300 | MessageTypeID | The MessageTypeID of an ApisMessage | 4 byte unsigned integer |
| 5301 | MessageCategory | The MessageCategory of an ApisMessage | 4 byte unsigned integer |
SECS/GEM related attributes
| ID | Name | Description | Type |
| 6000 | GemVID | The MessageTypeID of an ApisMessage | 4 byte unsigned integer |
| 6001 | GemVIDClass | The MessageCategory of an ApisMessage | 1 byte unsigned integer |
| 6010 | GemCEIDTrig | SECS/GEM Collection Event ID for item used as trigger. Values below 1000 are reserve for internal usage, and will be ignored on item attributes. | 4 byte unsigned integer |
| 6020 | GemTIDSnd | SECS/GEM Terminal ID for equipment generated text | 4 byte unsigned integer |
| 6021 | GemTIDRcv | SECS/GEM Terminal ID for host generated text | 4 byte unsigned integer |
| 6030 | GemALID | SECS/GEM Alarm ID of an alarm. Values below 1000 are reserved for internal usage, and will be ignored on item attributes. | 4 byte unsigned integer |
| 6031 | GemALCEIDOn | SECS/GEM Alarm CEID for an alarm going ON. | 4 byte unsigned integer |
| 6032 | GemALCEIDOff | SECS/GEM Alarm CEID for an alarm going OFF. | 4 byte unsigned integer |
IEC60870-5-104 Server related attributes
| ID | Name | Description | Type |
| 6100 | IEC104TypeID | IEC104 TypeID, used by IEC104 server to expose Apis items, enumeration of supported IEC104 TypeIDs: Not in use=0 Single point information [Bool]=1 Bitstring 32 bits [Int32,UInt32]=7 Measured value [Float32]=13 | 1 byte unsigned integer |
HoneyStore indexing related attributes
| ID | Name | Description | Type |
| 5150 | HSDimensionID | This attribute maps this item value to instances of a Dimension definition in the Apis HoneyStore Indexing database | string |
| 5151 | HSMeasurementID | This attribute maps this item value to instances of a Measurement definition in the Apis HoneyStore Indexing database | string |
| 5152 | HSLocationID | This attribute maps this item value to instances of a Location definition in the Apis HoneyStore Indexing database | string |